| Fully Qualified Name: | Laminas\Cache\Storage\Adapter\AdapterOptions |
| Extends: | AbstractOptions |
Unless otherwise marked, all options in this class affect all adapters.
| Name | Description | Defined By |
|---|---|---|
| __construct() | Constructor | AbstractOptions |
| __get() | Get a configuration property | AbstractOptions |
| __isset() | Test if a configuration property is null | AbstractOptions |
| __set() | Set a configuration property | AbstractOptions |
| __unset() | Set a configuration property to NULL | AbstractOptions |
| getKeyPattern() | Get key pattern | AdapterOptions |
| getNamespace() | Get namespace | AdapterOptions |
| getReadable() | If reading data from cache enabled. | AdapterOptions |
| getTtl() | Get time to live. | AdapterOptions |
| getWritable() | If writing data to cache enabled. | AdapterOptions |
| setAdapter() | Adapter using this instance | AdapterOptions |
| setFromArray() | {@inheritdoc} | AdapterOptions |
| setKeyPattern() | Set key pattern | AdapterOptions |
| setNamespace() | Set namespace. | AdapterOptions |
| setReadable() | Enable/Disable reading data from cache. | AdapterOptions |
| setTtl() | Set time to live. | AdapterOptions |
| setWritable() | Enable/Disable writing data to cache. | AdapterOptions |
| toArray() | Cast to array | AdapterOptions |
Constructor
| Parameter Name | Type | Description |
|---|---|---|
| $options | array|\Traversable|null |
Returns:
Get a configuration property
| Parameter Name | Type | Description |
|---|---|---|
| $key | string |
Returns: mixed
Test if a configuration property is null
| Parameter Name | Type | Description |
|---|---|---|
| $key | string |
Returns: bool
Set a configuration property
| Parameter Name | Type | Description |
|---|---|---|
| $key | string | |
| $value | mixed |
Returns: void
Set a configuration property to NULL
| Parameter Name | Type | Description |
|---|---|---|
| $key | string |
Returns: void
Get key pattern
Returns: string
Get namespace
Returns: string
If reading data from cache enabled.
Returns: bool
Get time to live.
Returns: float
If writing data to cache enabled.
Returns: bool
Adapter using this instance
| Parameter Name | Type | Description |
|---|---|---|
| $adapter | \StorageInterface|null |
Returns: \AdapterOptions Provides a fluent interface
{@inheritdoc}
NOTE: This method was overwritten just to support prioritized properties {@link https://github.com/zendframework/zf2/issues/6381}
| Parameter Name | Type | Description |
|---|---|---|
| $options | array|\Traversable|\AbstractOptions |
Returns: \AbstractOptions Provides fluent interface
Set key pattern
| Parameter Name | Type | Description |
|---|---|---|
| $keyPattern | string |
Returns: \AdapterOptions Provides a fluent interface
Set namespace.
| Parameter Name | Type | Description |
|---|---|---|
| $namespace | string |
Returns: \AdapterOptions Provides a fluent interface
Enable/Disable reading data from cache.
| Parameter Name | Type | Description |
|---|---|---|
| $readable | bool |
Returns: \AdapterOptions Provides a fluent interface
Set time to live.
| Parameter Name | Type | Description |
|---|---|---|
| $ttl | int|float |
Returns: \AdapterOptions Provides a fluent interface
Enable/Disable writing data to cache.
| Parameter Name | Type | Description |
|---|---|---|
| $writable | bool |
Returns: \AdapterOptions Provides a fluent interface
Cast to array
Returns: array